<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>dom.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">dom.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    Predefined DHTML animations such as slide, resize and fade.
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="http://closure-library.googlecode.com/git/closure/goog/demos/effects.html">Demo</a></li>
            <li><a href="closure_goog_fx_dom.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/closure/goog/fx/dom.js">Git</a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">fx/dom.js</div>
    </div>
  </div>
<hr/>


  <h2>Classes</h2>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_BgColorTransform.html">
          goog.fx.dom.BgColorTransform</a><br/>
        <div class="class-details">Provides a transformation of an elements background-color.

Start and End should be 3D arrays representing R,G,B</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_ColorTransform.html">
          goog.fx.dom.ColorTransform</a><br/>
        <div class="class-details">Provides a transformation of an elements color.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_Fade.html">
          goog.fx.dom.Fade</a><br/>
        <div class="class-details">Creates an animation object that fades the opacity of an element between two
limits.

Start and End should be floats between 0 and 1</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_FadeIn.html">
          goog.fx.dom.FadeIn</a><br/>
        <div class="class-details">Fades an element in from completely transparent to fully opacity.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_FadeInAndShow.html">
          goog.fx.dom.FadeInAndShow</a><br/>
        <div class="class-details">Sets an element's display to be visible and then fades an element in from
completely transparent to fully opacity</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_FadeOut.html">
          goog.fx.dom.FadeOut</a><br/>
        <div class="class-details">Fades an element out from full opacity to completely transparent.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_FadeOutAndHide.html">
          goog.fx.dom.FadeOutAndHide</a><br/>
        <div class="class-details">Fades an element out from full opacity to completely transparent and then
sets the display to 'none'</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_PredefinedEffect.html">
          goog.fx.dom.PredefinedEffect</a><br/>
        <div class="class-details">Abstract class that provides reusable functionality for predefined animations
that manipulate a single DOM element</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_Resize.html">
          goog.fx.dom.Resize</a><br/>
        <div class="class-details">Creates an animation object that will resize an element between two widths
and heights.

Start and End should be 2 dimensional arrays</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_ResizeHeight.html">
          goog.fx.dom.ResizeHeight</a><br/>
        <div class="class-details">Creates an animation object that will resize an element between two heights

Start and End should be numbers</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_ResizeWidth.html">
          goog.fx.dom.ResizeWidth</a><br/>
        <div class="class-details">Creates an animation object that will resize an element between two widths

Start and End should be numbers</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_Scroll.html">
          goog.fx.dom.Scroll</a><br/>
        <div class="class-details">Creates an animation object that will scroll an element from A to B.

Start and End should be 2 dimensional arrays</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_Slide.html">
          goog.fx.dom.Slide</a><br/>
        <div class="class-details">Creates an animation object that will slide an element from A to B.  (This
in effect automatically sets up the onanimate event for an Animation object)

Start and End should be 2 dimensional arrays</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_SlideFrom.html">
          goog.fx.dom.SlideFrom</a><br/>
        <div class="class-details">Slides an element from its current position.</div>
 </div>
 <div class="fn-constructor">
        <a href="class_goog_fx_dom_Swipe.html">
          goog.fx.dom.Swipe</a><br/>
        <div class="class-details">Creates an animation object that will slide an element into its final size.
Requires that the element is absolutely positioned.</div>
 </div>
      
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.dom.PredefinedEffect.apply"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.dom.PredefinedEffect.</span><span class="entryName">apply<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_dom.js.source.html#line59">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.dom.bgColorFadeIn"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.dom.</span><span class="entryName">bgColorFadeIn<span class="args">(<span class="arg">element</span>,&nbsp;<span class="arg">start</span>,&nbsp;<span class="arg">time</span>,&nbsp;<span class="arg">opt_eventHandler</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Fade elements background color from start color to the element's current
background color.

Start should be a 3D array representing R,G,B
     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">element</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/DOM/Element">Element</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
        <div class="entryOverview">Dom Node to be used in the animation.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">start</span>
        : <div class="fullType">(<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></span>.&lt;<span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span>&gt;<span>&nbsp;|&nbsp;</span><span class="type">null</span>)</div>
        <div class="entryOverview">3D Array for RGB of start color.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">time</span>
        : <div class="fullType"><span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number">number</a></span></div>
        <div class="entryOverview">Length of animation in milliseconds.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_eventHandler</span>
        : <div class="fullType">(<span class="type"><a href="class_goog_events_EventHandler.html">goog.events.EventHandler</a></span><span>&nbsp;|&nbsp;</span><span class="type">null</span><span>&nbsp;|&nbsp;</span><span class="type">undefined</span>)</div>
        <div class="entryOverview">Optional event handler to use when listening for events.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_dom.js.source.html#line590">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.dom.PredefinedEffect.call"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.dom.PredefinedEffect.</span><span class="entryName">call<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_dom.js.source.html#line59">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.dom.Slide.call"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.dom.Slide.</span><span class="entryName">call<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_dom.js.source.html#line143">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.fx.dom.Fade.call"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.fx.dom.Fade.</span><span class="entryName">call<span class="args">()</span>
        </span>
      </div>


     <div class="entryOverview">
       <span class='nodesc'>No description.</span>
     </div>

   
  </td>


  <td class="view-code">
     <a href="closure_goog_fx_dom.js.source.html#line410">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>






      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory fx</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="" current="fx/dom.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
